@kodiak-finance/orderly-trading-leaderboard 2.8.6 → 2.8.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +25 -9
- package/dist/index.d.ts +25 -9
- package/dist/index.js +31 -31
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +9 -9
- package/dist/index.mjs.map +1 -1
- package/package.json +9 -9
package/dist/index.d.mts
CHANGED
|
@@ -349,6 +349,11 @@ type TradingLeaderboardState = {
|
|
|
349
349
|
start_time: Date | string;
|
|
350
350
|
end_time: Date | string;
|
|
351
351
|
};
|
|
352
|
+
/** custom time range for leaderboard (supports 'now' for current date) */
|
|
353
|
+
timeRange?: {
|
|
354
|
+
from?: string | Date;
|
|
355
|
+
to?: string | Date | "now";
|
|
356
|
+
};
|
|
352
357
|
statistics?: CampaignStatistics;
|
|
353
358
|
setStatistics?: (statistics: CampaignStatistics) => void;
|
|
354
359
|
};
|
|
@@ -356,7 +361,7 @@ type TradingLeaderboardState = {
|
|
|
356
361
|
* Trading leaderboard context
|
|
357
362
|
*/
|
|
358
363
|
declare const TradingLeaderboardContext: react__default.Context<TradingLeaderboardState>;
|
|
359
|
-
type TradingLeaderboardProviderProps = Pick<TradingLeaderboardState, "campaigns" | "href" | "backgroundSrc" | "dataAdapter"> & {
|
|
364
|
+
type TradingLeaderboardProviderProps = Pick<TradingLeaderboardState, "campaigns" | "href" | "backgroundSrc" | "dataAdapter" | "timeRange"> & {
|
|
360
365
|
campaignId?: string | number;
|
|
361
366
|
onCampaignChange?: (campaignId: string | number) => void;
|
|
362
367
|
};
|
|
@@ -413,9 +418,13 @@ type GeneralRankingData = {
|
|
|
413
418
|
date: string;
|
|
414
419
|
perp_maker_volume: number;
|
|
415
420
|
perp_taker_volume: number;
|
|
416
|
-
perp_volume
|
|
417
|
-
realized_pnl
|
|
421
|
+
perp_volume?: number;
|
|
422
|
+
realized_pnl?: number;
|
|
418
423
|
total_fee: number;
|
|
424
|
+
total_perp_volume?: number;
|
|
425
|
+
total_maker_volume?: number;
|
|
426
|
+
total_taker_volume?: number;
|
|
427
|
+
total_pnl?: number;
|
|
419
428
|
key?: string;
|
|
420
429
|
rank?: number | string;
|
|
421
430
|
volume?: number;
|
|
@@ -427,18 +436,17 @@ type GeneralRankingScriptOptions = {
|
|
|
427
436
|
dateRange?: DateRange | null;
|
|
428
437
|
address?: string;
|
|
429
438
|
sortKey?: "perp_volume" | "realized_pnl";
|
|
430
|
-
|
|
439
|
+
leaderboardEndpoint?: string;
|
|
431
440
|
};
|
|
432
441
|
declare function useGeneralRankingScript(options?: GeneralRankingScriptOptions): {
|
|
433
442
|
pagination: _kodiak_finance_orderly_ui.PaginationMeta;
|
|
434
443
|
initialSort: TableSort;
|
|
435
444
|
onSort: (sort?: TableSort) => void;
|
|
436
|
-
dataSource:
|
|
445
|
+
dataSource: GeneralRankingData[];
|
|
437
446
|
isLoading: boolean;
|
|
438
|
-
isPointsLoading: boolean;
|
|
439
447
|
isMobile: boolean;
|
|
440
448
|
sentinelRef: react.MutableRefObject<HTMLDivElement | null>;
|
|
441
|
-
dataList:
|
|
449
|
+
dataList: GeneralRankingData[];
|
|
442
450
|
address: string | undefined;
|
|
443
451
|
};
|
|
444
452
|
|
|
@@ -474,6 +482,10 @@ type GeneralLeaderboardScriptOptions = {
|
|
|
474
482
|
start_time: Date | string;
|
|
475
483
|
end_time: Date | string;
|
|
476
484
|
};
|
|
485
|
+
timeRange?: {
|
|
486
|
+
from?: string | Date;
|
|
487
|
+
to?: string | Date | "now";
|
|
488
|
+
};
|
|
477
489
|
};
|
|
478
490
|
declare function useGeneralLeaderboardScript(options?: GeneralLeaderboardScriptOptions): {
|
|
479
491
|
activeTab: LeaderboardTab;
|
|
@@ -502,11 +514,15 @@ type GeneralLeaderboardProps = {
|
|
|
502
514
|
start_time: Date | string;
|
|
503
515
|
end_time: Date | string;
|
|
504
516
|
};
|
|
505
|
-
|
|
517
|
+
leaderboardEndpoint?: string;
|
|
518
|
+
timeRange?: {
|
|
519
|
+
from?: string | Date;
|
|
520
|
+
to?: string | Date | "now";
|
|
521
|
+
};
|
|
506
522
|
} & GeneralLeaderboardScriptReturn;
|
|
507
523
|
declare const GeneralLeaderboard: FC<GeneralLeaderboardProps>;
|
|
508
524
|
|
|
509
|
-
type GeneralLeaderboardWidgetProps = Pick<GeneralLeaderboardProps, "style" | "className" | "campaignDateRange" | "
|
|
525
|
+
type GeneralLeaderboardWidgetProps = Pick<GeneralLeaderboardProps, "style" | "className" | "campaignDateRange" | "leaderboardEndpoint" | "timeRange">;
|
|
510
526
|
declare const GeneralLeaderboardWidget: FC<GeneralLeaderboardWidgetProps>;
|
|
511
527
|
|
|
512
528
|
type CampaignLeaderboardScriptReturn = ReturnType<typeof useCampaignLeaderboardScript>;
|
package/dist/index.d.ts
CHANGED
|
@@ -349,6 +349,11 @@ type TradingLeaderboardState = {
|
|
|
349
349
|
start_time: Date | string;
|
|
350
350
|
end_time: Date | string;
|
|
351
351
|
};
|
|
352
|
+
/** custom time range for leaderboard (supports 'now' for current date) */
|
|
353
|
+
timeRange?: {
|
|
354
|
+
from?: string | Date;
|
|
355
|
+
to?: string | Date | "now";
|
|
356
|
+
};
|
|
352
357
|
statistics?: CampaignStatistics;
|
|
353
358
|
setStatistics?: (statistics: CampaignStatistics) => void;
|
|
354
359
|
};
|
|
@@ -356,7 +361,7 @@ type TradingLeaderboardState = {
|
|
|
356
361
|
* Trading leaderboard context
|
|
357
362
|
*/
|
|
358
363
|
declare const TradingLeaderboardContext: react__default.Context<TradingLeaderboardState>;
|
|
359
|
-
type TradingLeaderboardProviderProps = Pick<TradingLeaderboardState, "campaigns" | "href" | "backgroundSrc" | "dataAdapter"> & {
|
|
364
|
+
type TradingLeaderboardProviderProps = Pick<TradingLeaderboardState, "campaigns" | "href" | "backgroundSrc" | "dataAdapter" | "timeRange"> & {
|
|
360
365
|
campaignId?: string | number;
|
|
361
366
|
onCampaignChange?: (campaignId: string | number) => void;
|
|
362
367
|
};
|
|
@@ -413,9 +418,13 @@ type GeneralRankingData = {
|
|
|
413
418
|
date: string;
|
|
414
419
|
perp_maker_volume: number;
|
|
415
420
|
perp_taker_volume: number;
|
|
416
|
-
perp_volume
|
|
417
|
-
realized_pnl
|
|
421
|
+
perp_volume?: number;
|
|
422
|
+
realized_pnl?: number;
|
|
418
423
|
total_fee: number;
|
|
424
|
+
total_perp_volume?: number;
|
|
425
|
+
total_maker_volume?: number;
|
|
426
|
+
total_taker_volume?: number;
|
|
427
|
+
total_pnl?: number;
|
|
419
428
|
key?: string;
|
|
420
429
|
rank?: number | string;
|
|
421
430
|
volume?: number;
|
|
@@ -427,18 +436,17 @@ type GeneralRankingScriptOptions = {
|
|
|
427
436
|
dateRange?: DateRange | null;
|
|
428
437
|
address?: string;
|
|
429
438
|
sortKey?: "perp_volume" | "realized_pnl";
|
|
430
|
-
|
|
439
|
+
leaderboardEndpoint?: string;
|
|
431
440
|
};
|
|
432
441
|
declare function useGeneralRankingScript(options?: GeneralRankingScriptOptions): {
|
|
433
442
|
pagination: _kodiak_finance_orderly_ui.PaginationMeta;
|
|
434
443
|
initialSort: TableSort;
|
|
435
444
|
onSort: (sort?: TableSort) => void;
|
|
436
|
-
dataSource:
|
|
445
|
+
dataSource: GeneralRankingData[];
|
|
437
446
|
isLoading: boolean;
|
|
438
|
-
isPointsLoading: boolean;
|
|
439
447
|
isMobile: boolean;
|
|
440
448
|
sentinelRef: react.MutableRefObject<HTMLDivElement | null>;
|
|
441
|
-
dataList:
|
|
449
|
+
dataList: GeneralRankingData[];
|
|
442
450
|
address: string | undefined;
|
|
443
451
|
};
|
|
444
452
|
|
|
@@ -474,6 +482,10 @@ type GeneralLeaderboardScriptOptions = {
|
|
|
474
482
|
start_time: Date | string;
|
|
475
483
|
end_time: Date | string;
|
|
476
484
|
};
|
|
485
|
+
timeRange?: {
|
|
486
|
+
from?: string | Date;
|
|
487
|
+
to?: string | Date | "now";
|
|
488
|
+
};
|
|
477
489
|
};
|
|
478
490
|
declare function useGeneralLeaderboardScript(options?: GeneralLeaderboardScriptOptions): {
|
|
479
491
|
activeTab: LeaderboardTab;
|
|
@@ -502,11 +514,15 @@ type GeneralLeaderboardProps = {
|
|
|
502
514
|
start_time: Date | string;
|
|
503
515
|
end_time: Date | string;
|
|
504
516
|
};
|
|
505
|
-
|
|
517
|
+
leaderboardEndpoint?: string;
|
|
518
|
+
timeRange?: {
|
|
519
|
+
from?: string | Date;
|
|
520
|
+
to?: string | Date | "now";
|
|
521
|
+
};
|
|
506
522
|
} & GeneralLeaderboardScriptReturn;
|
|
507
523
|
declare const GeneralLeaderboard: FC<GeneralLeaderboardProps>;
|
|
508
524
|
|
|
509
|
-
type GeneralLeaderboardWidgetProps = Pick<GeneralLeaderboardProps, "style" | "className" | "campaignDateRange" | "
|
|
525
|
+
type GeneralLeaderboardWidgetProps = Pick<GeneralLeaderboardProps, "style" | "className" | "campaignDateRange" | "leaderboardEndpoint" | "timeRange">;
|
|
510
526
|
declare const GeneralLeaderboardWidget: FC<GeneralLeaderboardWidgetProps>;
|
|
511
527
|
|
|
512
528
|
type CampaignLeaderboardScriptReturn = ReturnType<typeof useCampaignLeaderboardScript>;
|